GetPlatformShape

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODShape

GetPlatformShape
The GetPlatformShape method returns a graphics-system-specific data structure representing this shape.
ODPlatformShape GetPlatformShape (
                     in ODGraphicsSystem graphicsSystem);
graphicsSystem
A 16-bit value specifying the graphics system you want to use for this shape. Valid graphics systems are platform dependent.
return value
A 32-bit value identifying the requested graphics-system-specific shape. Before using the return value, you must cast it to a valid graphics system type (such as RgnHandle for QuickDraw or gxShape for QuickDraw GX).

DISCUSSION
The type of the returned value depends on the specified graphics system. On the Mac OS platform, the graphics system may be either QuickDraw (kODQuickDraw) or QuickDraw GX (kODQuickDrawGX).

If you specify the QuickDraw graphics system, the returned value is a QuickDraw region handle (type RgnHandle). This region handle belongs to the shape; you cannot modify it or deallocate its storage. The region and its contents are valid only until the next operation on this shape.
If you specify the QuickDraw GX graphics system, the returned value is a QuickDraw GX shape (type gxShape). You cannot modify this QuickDraw GX shape. However, when you no longer need it, you are responsible for deallocating its storage.

EXCEPTIONS

kODErrInvalidGraphicsSystem
This implementation of OpenDoc does not support the specified graphics system, or that graphics system is not installed or available.

SEE ALSO
The ODGraphicsSystem type (page 883).
The ODShape::SetPlatformShape method (page 650).